home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Software of the Month Club / Amiga General Interest Volume 217 (1995)(SOMC)(Disk 7 of y)[SMCxxxC30Ix].zip / Amiga General Interest Volume 217 (1995)(SOMC)(Disk 7 of y)[SMCxxxC30Ix].adf / Planetarium.doc < prev    next >
Text File  |  1995-06-23  |  14KB  |  451 lines
  1. Document Planetarium documentation
  2.                                 Planetarium
  3.                           FRIENWARE-Version 2.50
  4.                           ======================
  5.  
  6.  
  7. 1. FEATURES
  8.    ========
  9.  
  10. - can easily be configured via ascii-files
  11.  
  12. - pictures for telescope mode are automatically recognized
  13.  
  14. - functions can be chosen by `DROPDOWN MENUS', `SHORTCUTS' or `GADGETS'
  15.  
  16. - slideshow-mode
  17.  
  18. - double-buffered-display ! ( see `KNOWN BUGS' )
  19.  
  20. - friendly with multitasking : while nothing happens, task is set to
  21.   'waiting'
  22.  
  23. - saves its `default settings' at the end of a session
  24.  
  25. - can always be switched to `other languages'
  26.  
  27. - now shows a lot more of stars and other objects
  28.  
  29.  
  30. 2. Some remarks
  31.    ============
  32.  
  33. This program was originally written for the C64 by H. Hinkelmann and first
  34. published in the C64 Magazin 5/85 (Markt & Technik).
  35.  
  36. I ported it to the Amiga, adding a lot of stars and new features, making 
  37. use of intuition, thus re-coding the whole thing.
  38. I reorganized the whole stucture of the program and its routines speeding
  39. them up and that's why I sign as author.
  40.  
  41. Meanwhile the program is quite stable and as I have put a lot of time
  42. into it I give you the newest version as FRIENDWARE, which means I hope
  43. you will write me a letter, if you  enjoy this program.
  44.  
  45. If you register you will be informed when a new version is available.
  46.  
  47. Anyway, donations (money, science fiction of all kind, CD's, cars,
  48. houses...) are wellcome and will entitle you to a free update (if there is
  49. one) and the sourcecode.
  50.  
  51. --------------------------------------------------------------------------
  52. ATTENTION!! I MAY NOT BE HELD RESPONSIBLE FOR ANY DAMAGE THIS PROGRAM
  53. MIGHT DO TO YOUR HARDWARE, SOFTWARE, TUPPERWARE OR BRAIN, SO BE CAREFUL!
  54. --------------------------------------------------------------------------
  55.  
  56. Orginally written on a 1Meg A2000 under Kick 1.3 the program turned out
  57. to run well with 1Meg chipmemory and 6Meg fastram under Kick 2.x and the
  58. A2630, though some "friends" of GFA-basic would not expect it.
  59.  
  60. (-> `KNOWN BUGS')
  61.  
  62.  
  63.  
  64.                                  ATTENTION
  65.                                  =========
  66.  
  67. I encourage you to pass this package to anyone you want under the condition
  68. that the files remain unchanged and complete! (see `copyright')
  69.                       ======================
  70.  
  71. 3. Contents
  72.    ========
  73.  
  74.  - three archivs
  75.     
  76.     TELE1.LHA    graphics for telescope-mode and diashow
  77.  
  78.     TELE2.LHA    additional graphics
  79.  
  80.     PLAN.LHA    containing
  81.                 
  82.  
  83.                  - Planetarium_2.50         main program
  84.                  - Planetarium_2.50.info    program icon
  85.                  - Planetarium.c            compiled version (without double-
  86.                                             buffering for AGA and slow Amigas)
  87.                  - Planetarium.c.info       program icon
  88.                  - Planetarium.guide.info   texticon
  89.                  - Planetarium.guide        german/english guide
  90.                  - about.eng                ASCII-file for Info (english)
  91.                  - about.fra                ASCII-file for Info (french)
  92.                  - about.ger                ASCII-file for Info (german)
  93.                  - const.eng                ASCII-file for constellations
  94.                  - const.fra                ASCII-file for constellations
  95.                  - const.ger                ASCII-file for constellations
  96.                  - defstrings.eng           ASCII-file with all needed strings
  97.                  - defstrings.fra           s.a. french version
  98.                  - defstrings.fer           s.a. german version
  99.                  - preset.data              ASCII-file for presets
  100.                  - planet.data              ASCII-file for planets
  101.                  - starneu.data             ASCII-file for stars
  102.                  - gfabasro                 Run-only-Interpreter
  103.  
  104. and the files
  105.  
  106.                  - MuchMore                     textviewer
  107.                  - BITTE_LESEN.info             texticon
  108.                  - BITTE_LESEN                  installationhelp german
  109.                  - READ_ME_FIRST.info           texticon
  110.                  - READ_ME_FIRST                Installationhelp english
  111.                  - Installer                    Commodores utility
  112.                  - Install-Planetarium          simple installerscript
  113.                  - Install-Planetarium.info     scripticon
  114.                  - AmigaGuide                   Commodore utility
  115.  
  116.                - libs                           library-drawer
  117.                     - amigaguide.library
  118.  
  119.                - tools                          tools-drawer
  120.                     - LhA                       (de-)archiving utility
  121.                     - LhaPatterns               utilityprogram for lha
  122.  
  123.  
  124. 4. Overview
  125.    ========
  126.  
  127. PLANETARIUM draws a chart of stars from horizon to horizon for any place
  128. on earth and any reasonable time (it calculates the Julian Date).
  129.  
  130.  +------------------------------------------------------------------------+
  131.  | It starts with the time (and date) it gets from your system, expecting |
  132.  | you to live in the timezone of the first pre-set place. If you do not, |
  133.  | you should correct this in  preset.data using any ASCII-editor.        |
  134.  +------------------------------------------------------------------------+
  135.  
  136. You can change time and date selecting the appropriate item from the 
  137. pulldown-menu.
  138.  
  139. Most stars down to third magnitude are shown and some fainter are added where
  140. the constellation requires them. Magnitude and apparent brightness correspond
  141. to the colours (grayscale) used by the program, planets are marked red.
  142.  
  143. PLANETARIUM has the intention to help the astronomical beginner:
  144.  
  145. First, it helps to locate stars, constellations and planets.
  146. Point at a star on the chart and press the left mousebutton:
  147. A circle is drawn around it, its name and that of its constellation are
  148. displayed while the other stars of the constellation are blinking.
  149.  
  150. If you know the name of a star, planet or constellation and don't know where it
  151. is, select 'Look for names' from the `DROPDOWN MENUS' , enter the name or part 
  152. of it and everything will be displayed as mentioned above.
  153.  
  154. Second, PLANETARIUM is able to simulate the movements of celestial objects.
  155. Just select 'Planetarium' from the 'MODE'-menu or click its icon. Choosing an
  156. twentyfour-hour interval will show you the motion of sun, moon and planets in front of
  157. the fixed stars.
  158.  
  159.  
  160.  
  161. 5. Functions
  162.    =========
  163.  
  164.  
  165. 5.1. DROPDOWN MENUS  
  166.      ~~~~~~~~~~~~~~
  167.  
  168. 5.1.1. - Program
  169.          -------
  170.  
  171.     - continue    actualizes screen and time
  172.  
  173.     - quit        leave the program
  174.  
  175.     - about        version, copyrightnotice and adress are shown
  176.  
  177. 5.1.2. - Change parameters
  178.          -----------------
  179.  
  180.     - Location    enter coordinates of any place on earth
  181.  
  182.     - Date/Time    enter any reasonable time and date
  183.  
  184.     - Pre-set locations    direct selection of places the coordinates
  185.                 and names of which are stored in the
  186.                 ASCII-file preset.data (configurable!)
  187.  
  188.     - Systemtime    reset to systemtime
  189.  
  190. 5.1.3. - Mode
  191.          ----
  192.  
  193.     - Starchart    static
  194.  
  195.     - Planetarium    dynamic -> after a selectable delay time is
  196.             increased by a choosen interval. Other functions
  197.             are blocked!
  198.  
  199.     - Telescope    klicking on objects the pictures of which are
  200.             stored in the subdirectory \tele or te volume tele:
  201.             will display the picture
  202.  
  203. 5.1.4. - Resolution
  204.          ----------
  205.  
  206.     - 640*502
  207.             have a guess!
  208.     - 640*251
  209.  
  210. ---------------------------------------------------------------------------
  211. ATTENTION!! If you are short of memory you should select lores immediately
  212. when the explaining text is displayed!
  213. ---------------------------------------------------------------------------
  214.  
  215. 5.1.5. - Look for
  216.          --------
  217.  
  218.     - name        searches for star or constellation with the
  219.             specific name; german and latin names can be found
  220.             and edited according to your needs in the ASCII
  221.             file star.data or planet.data
  222.  
  223. 5.1.6.  - Print
  224.            -----
  225.  
  226.     - hardcopy    resets colours to black and white and prints the
  227.             screen using the default driver of your workbench.
  228.             Be sure it is available!
  229.  
  230.     - names in chart    prints the name beneath any selected object
  231.                 on the screen
  232.  
  233.  
  234. 5.2. GADGETS
  235.      =======
  236.  
  237. In hires-mode six icons and a 'quit' gadget are available:
  238.  
  239. first row:
  240. ----------
  241.  
  242. - clock        set time
  243.  
  244. - earth        set place
  245.  
  246. - printer    hardcopy
  247.  
  248.  
  249. second row:
  250. -----------
  251.  
  252. - mag. glass    telescope mode on/off
  253.  
  254. - projector    diashow; all available pictures in the subdirectory /tele
  255.         or the volume tele: are displayed. Left mousebutton gets
  256.         next picture, right button cancels mode.
  257.  
  258.        ---> pictures should be in ACBM-format <---
  259.        ---> names must end with ' .pic '      <---
  260.  
  261. - planetarium    animation mode on/off
  262.  
  263.  
  264. third row
  265. ---------
  266.  
  267. - QUIT        quit program
  268.  
  269.  
  270. Clicking on the close gadget of the window has the same result.
  271. The sizing gadget is not yet supported
  272.  
  273.  
  274. 5.3. SHORTCUTS
  275.      =========
  276.  
  277. SHORTCUTS are shown on the right side of the menuitems
  278.  
  279.  
  280. 5.4. Other languages
  281.      ===============
  282.  
  283. All strings for `DROPDOWN MENUS' and messages can be found in
  284. defstrings.xxx and can be changed with any ascii-editor.
  285.  
  286. Take care:
  287.                 - don't kill     , ; ! -
  288.                                  -------   
  289.  
  290.                 - don't alter the length of strings to much (try out) and
  291.                   take care of blanks
  292.  
  293.  
  294. 6. Default Settings
  295.    ================
  296.  
  297. When leaving the program regularly (via QUIT e.a.) default settings are saved
  298. in S:plan.prefs (1.e. language, place etc.)
  299.  
  300. Next time they are available the moment you start PLANETARIUM!
  301.  
  302.  
  303. 7. KNOWN BUGS
  304.    ==========
  305.  
  306.  
  307.         - in planetarium mode you should not press the buttons for
  308.           a longer period than the chosen delay
  309.  
  310.                 - on AGA-machines colours of ACBM-files are a bit odd
  311.  
  312.                 - some commodities don't work with PLANETARIUM (blankers...)
  313.  
  314. Due to the use of a lot of system functions the double-buffering program 
  315. can not be compiled at this time, therefor it might not run on A1200, 
  316. A3000, A4000.
  317.  
  318. I compiled a version without this feature and this should work on all Amigas.
  319.  
  320. Any idea what I can do? Please help me if you can!
  321.  
  322. 8. COPYRIGHT
  323.    =========
  324.  
  325. You may NOT use the program commercially in any way (read: sell it or make 
  326. any money with it or parts of it)! Distribution in public-domain-series is
  327. welcome as long as a disk or copying fee does not exagerate 10,-DM, e.g.
  328. about 7$.
  329.                   © Remember this stuff is copyrighted! (see `AUTHOR'
  330. --------------------------------------------------------------------------
  331.  
  332.  
  333.  
  334. 9. Program history
  335.    ===============
  336.  
  337. Version 0.98i  (not released)
  338. -------------
  339. I fixed a few bugs and added a preset feature for some well known (Wünnenberg??)
  340. or interesting locations.
  341. Now the MedRes-screen is built up properly and the GURU will not come up any
  342. more when you use some strange coordinates.
  343. A friend asked me for an entire english version, so I translated everything
  344. the best I could - even the names of variables and subroutines in the source -
  345. so that everybody might be able to understand what the program is doing
  346. (Version 0.98i means "international" haha).
  347.  
  348.  
  349. Version 0.99i (not released)
  350. -------------
  351. I worked on the routines to speed them up. Where it is possible the program
  352. now uses integer instead of floatingpoint variables.
  353.  
  354. Version 1.0i
  355. ------------
  356. I checked the trigonometric functions and used the fast GFA routines where
  357. speed was more important than precision. This payed!! The compiled version
  358. now only needs about three seconds to calculate and draw! an image of the
  359. sky. I called this version 1.0i because during testing no serious mistake
  360. occured (though there might be still some more bugs in it).
  361.  
  362. Version 1.01i (not released)
  363. -------------
  364. I changed the palette so that the brightness of the stars can be displayed
  365. properly. Adding one more bitplane to the screen would slow down the program
  366. by half.
  367.  
  368. Version 1.02i (not released)
  369. -------------
  370. One minor bug in the blink routine eliminated.
  371.  
  372. Version 1.1i
  373. -----------
  374. I added a feature to calculate the phases of the moon and the possibility to
  375. print the names of the stars you klick at into the screen.
  376.  
  377. Version 1.11i (not released)
  378. -------------
  379. The moon is no longer a simple circle because I added a picture for the
  380. phases!
  381.  
  382. Version 1.12i
  383. -------------
  384. Now the moon is shown correctly even non-interlaced.
  385.  
  386. Version 1.13i
  387. -------------
  388. Pictures of the moon are now integrated in the source-code (inline).
  389. Using the latest version of GFA Basic and Compiler (Version 3.52)
  390. made some minor bugs disappear.
  391.  
  392. Version 1.15i to 1.85i (not released)
  393. ----------------------
  394. I added the booleangadget routine to make program handling more easy. 
  395. Configuration ability via ASCII files implemented.
  396.  
  397. Version 2.0
  398. -----------
  399. Double buffering implemented --> better animations
  400. No more loops, when the program looks for inputs; the task is just waiting
  401. for an event, so multitasking is better!
  402.  
  403. Version 2.01
  404. ------------
  405. Extended presets; got rid of a minor bug in gadgetroutines
  406.  
  407.  
  408. Version 2.02  (22.01.1994)
  409. ------------
  410.  
  411. Enabeled sort of "localizing" via defstrings.data and thus added english
  412. and french version
  413.  
  414. Version 2.03  (21.04.1994)
  415. ------------
  416. Cleared up the code a bit and "localized" the information displayed each
  417. time you start the program (about.data). You can edit it the way you like.
  418. Added star.data.english
  419.  
  420. Version 2.04  (23.4.1994)
  421. ------------
  422. Finally corrected the routine calculating Greenwich time from systemtime.
  423. Now it should work for every first defaultposition!
  424.  
  425. Version 2.50 (22.6.1995)
  426. ------------
  427. A major update! Changed the structure of the stars' file (starneu.data)
  428. so the old file cannot be used any more.
  429. Well, for more look at `FEATURES'
  430.  
  431. 10. Author
  432.     ======
  433.  
  434. If you want to contact me write to
  435.  
  436.         Rolf Kühr
  437.         Am Südhang 21
  438.         D 33181 Wünnenberg (Germany)
  439.         Tel.:49-2953-8701
  440.  
  441.  
  442. or try to reach me via e-mail (german Zerberus-net):
  443.  
  444.         Sokrates@MF.ZER
  445.  
  446.  
  447.  
  448. That's all folks, enjoy!
  449.  
  450. Rolf Kühr
  451.